/*
 *  linux/kernel/sys.c
 *
 *  (C) 1991  Linus Torvalds
 */

#include <errno.h>              // 错误号头文件。包含系统中各种出错号。（Linux从MINUX中引进的）

#include <linux/sched.h>        // 调度程序头文件。定义任务结构 task_struct，初始任务0的数据
#include <linux/tty.h>          // tty 头文件，定义了有关tty_io，串行通信方面的参数，常数。
#include <linux/kernel.h>       // 内核头文件。含有一些内核常用函数的原型定义。
#include <asm/segment.h>        // 段操作头文件。定义了有关段寄存器操作的嵌入式汇编函数.
#include <sys/times.h>          // 定义了进程中运行时间的结构tms以及times（）函数原型
#include <sys/utsname.h>        // 系统名称结构头文件

int sys_ftime()                 // 返回日期和时间
{
	return -ENOSYS;
}

int sys_break()
{
	return -ENOSYS;
}

int sys_ptrace()                // 用于当前进程对子进程进行调试（debugging）
{
	return -ENOSYS;
}

int sys_stty()                  // 改变并打印终端行设置
{
	return -ENOSYS;
}

int sys_gtty()                  // 取终端行设置信息
{
	return -ENOSYS;
}

int sys_rename()                // 修改文件名
{
	return -ENOSYS;
}

int sys_prof()
{
	return -ENOSYS;
}
// 设置当前人物的实际以及/或者有效组ID（gid）。如果任务没有超级用户特权，那么只能互换其实际组ID和有效组ID。
int sys_setregid(int rgid, int egid)// 如果任务具有超级用户特权，就能任意设置有效的和实际的组ID。保留的（saved gid）呗设置成与有效gid同值
{
	if (rgid>0) {
		if ((current->gid == rgid) || 
		    suser())
			current->gid = rgid;
		else
			return(-EPERM);
	}
	if (egid>0) {
		if ((current->gid == egid) ||
		    (current->egid == egid) ||
		    (current->sgid == egid) ||
		    suser())
			current->egid = egid;
		else
			return(-EPERM);
	}
	return 0;
}
// 设置进程组号（gid）。如果任务没有超级用户特权，它可以使用setgid（）将其有效gid（effective gid）设置成其保留gid（savedgid）或其实际gid（real gid）。
int sys_setgid(int gid) // 如果任务有超级用户特权，则实际gid 有效gid和保留gid都被设置成参数指定的gid
{
	return(sys_setregid(gid, gid));
}

int sys_acct()  // 打开或关闭进程计帐功能
{
	return -ENOSYS;
}

int sys_phys()  // 映射任意物理内存到进程的虚拟地址空间
{
	return -ENOSYS;
}

int sys_lock()
{
	return -ENOSYS;
}

int sys_mpx()
{
	return -ENOSYS;
}

int sys_ulimit()
{
	return -ENOSYS;
}
// 返回从1970.1.1.00：00：00GMT 开始的时间（s）。若tloc不为null 则时间值也存储在那里
int sys_time(long * tloc)
{
	int i;

	i = CURRENT_TIME;
	if (tloc) {
		verify_area(tloc,4);    // 验证内存容量是否够（这里是4字节）
		put_fs_long(i,(unsigned long *)tloc);   // 也放入用户数据段 tloc 处
	}
	return i;
}
// 无特权用户可将实际用户标识符改成有效用户标识符（euid），反之亦然
/*
 * Unprivileged users may change the real user id to the effective uid
 * or vice versa.
 */// 设置任务的实际以及/或者有效用户ID（uid）。如果任务没有超级用户特权，那么只能互换其实际有能用户ID和有效用户ID。如果任务具有超级用户特权
int sys_setreuid(int ruid, int euid)// 就能任务设置有效和实际的用户ID。保留uid被设置成有效uid同值
{
	int old_ruid = current->uid;
	
	if (ruid>0) {
		if ((current->euid==ruid) ||
                    (old_ruid == ruid) ||
		    suser())
			current->uid = ruid;
		else
			return(-EPERM);
	}
	if (euid>0) {
		if ((old_ruid == euid) ||
                    (current->euid == euid) ||
		    suser())
			current->euid = euid;
		else {
			current->uid = old_ruid;
			return(-EPERM);
		}
	}
	return 0;
}
// 设置任务用户号（uid）。如果任务没有超级用户特权，它可以使用setuid（）将其有效uid（euid）设置成其保留uid（saved uid）或其实际uid（real uid）
int sys_setuid(int uid) // 如果任务有超级用户特权，则实际uid 有效uid 保留uid 都被设置成参数指定的uid
{
	return(sys_setreuid(uid, uid));
}
// 设置系统时间和日期。参数tptr是从1970年1月1号00：00：00（格林尼治时间）开始计时的时间值（s）
int sys_stime(long * tptr)
{                       // 调用进程必须具有超级用户权限
	if (!suser())       // 如果不是超级用户则出错返回（许可）
		return -EPERM;
	startup_time = get_fs_long((unsigned long *)tptr) - jiffies/HZ;
	return 0;
}
// 获取当前任务时间。 tms 结构中包括用户时间 系统时间 子进程用户时间 子进程系统时间
int sys_times(struct tms * tbuf)
{
	if (tbuf) {
		verify_area(tbuf,sizeof *tbuf);
		put_fs_long(current->utime,(unsigned long *)&tbuf->tms_utime);
		put_fs_long(current->stime,(unsigned long *)&tbuf->tms_stime);
		put_fs_long(current->cutime,(unsigned long *)&tbuf->tms_cutime);
		put_fs_long(current->cstime,(unsigned long *)&tbuf->tms_cstime);
	}
	return jiffies;
}
// 当参数 end-data-seg数值合理，并且系统确实有足够的内存，而且进程没有超越其最大数据段大小时，改函数设置数据段末尾为end—data-seg的值。
int sys_brk(unsigned long end_data_seg) // 该值必须大于代码结尾并且要小于推展结尾 16KB
{   // 返回值是数据段的新结尾值（如果返回值与要求值不同，则表明有错误发生）。该函数并不被用户直接调用，而由libc库函数进行包装，并且返回值也不一样
	if (end_data_seg >= current->end_code &&    // 如果参数>代码结尾，并且小于对战-16KB
	    end_data_seg < current->start_stack - 16384)    // 则设置新数据段结尾值
		current->brk = end_data_seg;    // 返回进程当前的数据段结尾值
	return current->brk;
}
// 下面代码需要某些严格的检查 我只是没有胃口做这些。我也不完全明白 sessions/pgrp等。还是让了解他们的人来做吧
/*
 * This needs some heave checking ...
 * I just haven't get the stomach for it. I also don't fully
 * understand sessions/pgrp etc. Let somebody who does explain it.
 */ // 将参数pid指定进程的进程组ID设置成pgid。如果参数pid=0则使用当前进程号。如果pid为0，则使用参数pid指定的进程的组ID作为pgid。如果该函数用于将进程从一个进程组移到另一个进程组
int sys_setpgid(int pid, int pgid)  // 则这两个进程组必须属于同一个会话（session）。在这种情况下，参数pgid指定了要加入的现有进程组ID，此时该组的绘画ID必须与将要加入进程的相同
{
	int i;

	if (!pid)                       // 如果参数pid=0 则使用当前进程号
		pid = current->pid;
	if (!pgid)                      // 如果pgid为0，则使用当前进程pid作为pgid
		pgid = current->pid;        // 【这里与posix的描述有出入】
	for (i=0 ; i<NR_TASKS ; i++)    // 扫描任务数组，查找指定进程号的任务
		if (task[i] && task[i]->pid==pid) {
			if (task[i]->leader)    // 如果该任务已经是首领 则 出错返回
				return -EPERM;
			if (task[i]->session != current->session)   // 如果该任务的会话ID
				return -EPERM;      // 与当前进程的不同，则出错返回。
			task[i]->pgrp = pgid;   // 设置该任务的pgrp
			return 0;
		}
	return -ESRCH;
}

int sys_getpgrp(void)               // 返回当前进程的组号 与getpgid（0）等同
{
	return current->pgrp;
}
// 创建一个会话（session）（即设置其leader=1），并且设置其会话=其组号=其进程号
int sys_setsid(void)
{
	if (current->leader && !suser())    // 如果当前进程已是会话首领并且不是超级用户 则出错返回
		return -EPERM;
	current->leader = 1;                // 设置当前进程为新会话首领
	current->session = current->pgrp = current->pid;    // 设置本进程session=pid
	current->tty = -1;                  // 标识当前进程没有控制终端
	return current->pgrp;               // 返回会话ID
}
// 获取系统信息。其中utsname结构包含5个字段，分别是 本版本操作系统名称 网络节点名称 当前发行级别 版本级别和硬件类型名称
int sys_uname(struct utsname * name)
{
	static struct utsname thisname = {  // 这里给出了结构中的信息，这种编码肯定会改变
		"linux .0","nodename","release ","version ","machine "
	};
	int i;

	if (!name) return -ERROR;           // 如果存放信息的缓冲区指针为空则出错返回
	verify_area(name,sizeof *name);     // 验证缓冲区大小是否超限（超出已分配的内存等）
	for(i=0;i<sizeof *name;i++)         // 将utsname中的信息逐字节复制到用户缓冲区中。
		put_fs_byte(((char *) &thisname)[i],i+(char *) name);
	return 0;
}
// 设置当前进程创建文件属性屏蔽码为 mask&0777 并返回原屏蔽码
int sys_umask(int mask)
{
	int old = current->umask;

	current->umask = mask & 0777;
	return (old);
}
